/* Copyright 2002-2024 CS GROUP
 * Licensed to CS GROUP (CS) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * CS licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.orekit.files.ccsds.utils.lexical;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;

import org.orekit.utils.units.Unit;
import org.orekit.utils.units.UnitsCache;

/** Regular builder using XML elements names and content for tokens.
 * <p>
 * Each tag generates exactly one token, either a {@link TokenType#START START},
 * or {@link TokenType#STOP STOP} token without content for non-leaf elements,
 * or a {@link TokenType#ENTRY ENTRY} token with content for leaf elements.
 * </p>
 * @author Luc Maisonobe
 * @since 11.0
 */
public class RegularXmlTokenBuilder implements XmlTokenBuilder {

    /** Attribute name for units. */
    private static final String UNITS = "units";

    /** Cache for parsed units. */
    private final UnitsCache cache;

    /** Simple constructor.
     */
    public RegularXmlTokenBuilder() {
        this.cache = new UnitsCache();
    }

    /** {@inheritDoc} */
    @Override
    public List<ParseToken> buildTokens(final boolean startTag, final boolean isLeaf, final String qName,
                                        final String content, final Map<String, String> attributes,
                                        final int lineNumber, final String fileName) {

        if (startTag) {
            return Collections.singletonList(new ParseToken(TokenType.START, qName, content, Unit.NONE, lineNumber, fileName));
        } else {
            final List<ParseToken> built = new ArrayList<>(2);
            if (isLeaf) {
                // get units
                final Unit units = cache.getUnits(attributes.get(UNITS));
                built.add(new ParseToken(TokenType.ENTRY, qName, content, units, lineNumber, fileName));
            }
            built.add(new ParseToken(TokenType.STOP, qName, null, Unit.NONE, lineNumber, fileName));
            return built;
        }

    }

}
